Vendor Family Product Metadata
Provides metadata information for supported vendor, family and product information referenced from scan templates.
Base URL
https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors
Supported Requests
Method | URL | Input | Return |
---|---|---|---|
GET |
https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors |
Input Model
Name | Type | Description |
---|---|---|
count |
Integer |
Provide the count of items to return. The default is 10 and the maximum value is 1000. |
start |
Integer |
Sets the starting point. The items are sorted by their unique identifier and the starting point is the index into that sorted list. |
Example with Sample Response
GET Request
https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors?start=16&count=1
Sample Response
{
"count": 1,
"links": {
"next": {
"href": "https://device-name.example.com:3121/st/console/api/v1.0/metadata/vendors?count=1&start=17"
}
},
"value": [
{
"families": [
{
"products": [
{
"id": 944,
"name": "Winamp"
},
{
"id": 945,
"name": "Winamp 5"
}
],
"productVersions": [
{
"products": [
{
"name": "Winamp Full",
"productLevels": [
{
"id": 0,
"name": "Gold",
"uid": "0000059b-0001-0000-0000-000000000000"
}
],
"uid": "00000434-0000-0000-0000-000000000000"
},
{
"name": "Winamp Lite",
"productLevels": [
{
"id": 0,
"name": "Gold",
"uid": "0000059d-0001-0000-0000-000000000000"
}
],
"uid": "00000436-0000-0000-0000-000000000000"
}
],
"version": "5.0",
"id": 944,
"name": "Winamp"
},
{
"products": [
{
"name": "Winamp 5 Full",
"productLevels": [
{
"id": 0,
"name": "Gold",
"uid": "0000059a-0001-0000-0000-000000000000"
}
],
"uid": "00000433-0000-0000-0000-000000000000"
},
{
"name": "Winamp 5 Lite",
"productLevels": [
{
"id": 0,
"name": "Gold",
"uid": "0000059c-0001-0000-0000-000000000000"
}
],
"uid": "00000435-0000-0000-0000-000000000000"
}
],
"version": "5.0",
"id": 945,
"name": "Winamp 5"
}
],
"id": 164,
"name": "Winamp"
}
],
"id": 16,
"name": "Nullsoft"
}
]
}
Output Models
Name | Type | Description |
---|---|---|
families |
The list of families for this vendor. |
|
id |
Integer |
The ID of the vendor. Used for including or excluding vendors in the patch scan template. |
name |
String |
The name of the vendor. |
Name | Type | Description |
---|---|---|
id |
Integer |
The ID of the family. Used for including or excluding families in the patch scan template. |
name |
String |
The name of the family. |
products |
The list of products for this family. This parameter will be deprecated in a future release. Use productVersions in all new requests. |
|
productVersions |
The list of products for this family. |
Name | Type | Description |
---|---|---|
id |
Integer |
The unique ID used to identify a particular product version. Used for including or excluding products in the patch scan template. |
name |
String |
The product name and version number. |
Name | Type | Description |
---|---|---|
id |
Integer |
The unique ID used to identify a particular product version. Used for including or excluding products in the patch scan template. |
name |
String |
The product name. |
products |
The name, uid and the available product levels for the specific version of the product. |
|
version |
Integer |
The product version. |
Name | Type | Description |
---|---|---|
name |
String |
The product name. |
productLevels |
NameId[] |
The product levels that are available for the product. Each product level contains the following:
|
uid |
Guid |
The unique ID used to identify a particular product level or service pack revision. This can be used to correlate product vendor information to missing service packs in assessment results or for deployments. |